widgets.brease.GroupBox

Widget Description

short: Rahmen mit Label
de: Zeigt einen Rahmen um eine Gruppe von Widgets; optional mit einem Beschriftungstext
en: Displays a frame around a group of widgets with an optional caption

Properties

name description category type defaultValue bindable readOnly required localizable editableBinding projectable cssProp (has no setter and getter in JS) groupRefId groupOrder nodeRefId (for linking node and value) deprecated typeRefId (for StyleReference) subtype (for MpComIdentReference)
alignment Alignment of the Bar. Possible Values: horizontal: elements aligned from left to right. no line break vertical: elements aligned from left to right. with line break Appearance brease.enum.Direction vertical false false false false false true
childPositioning positioning of child elements (widgets) Behavior brease.enum.ChildPositioning absolute false false false false false true
ellipsis ellipsis for the Label Behavior Boolean false false false false false false true
enable Initial option to enable widget. Behavior Boolean true true false false false false true
float Floating of the childelements if childPositioning=relative Appearance brease.enum.Floating left false false false false false true
image Image path for the Label When svg - graphics are used, be sure that in your *.svg-file height and width attributes are specified on the svg-element. For more detailed information see https://www.w3.org/TR/SVG/struct.html (chapter 5.1.2) Appearance ImagePath false false false false false true
imageAlign imageAlign for the Label defines the Position of the image relative to the text possible values: left(left of text)/right(right of text) Appearance brease.enum.ImagePosition left false false false false false true
maxHeight Maximum height the GroupBox can grow, when childPositioning='relative' Appearance Integer 0 false false false false false true
permissionOperate restricts operability to users, which have given roles Accessibility RoleCollection no defaultValue
defined		 false false false false false true
permissionView restricts visibility to users, which have given roles Accessibility RoleCollection no defaultValue
defined		 false false false false false true
style reference to a style for this widget type Appearance StyleReference default true false false false false true
tabIndex sets if a widget should have autofocus enabled (0), the order of the focus (>0), or if autofocus should be disabled (-1) Behavior Integer -1 false false false false false true
text text for the Label Appearance String false false false true false true
tooltip reference to a tooltip for a widget Appearance String false false false true false true
useSVGStyling Define if the image stylings (i.e imageColor) are applied - only valid when SVG Images are used. Appearance Boolean true false false false false false true
visible change visibility Behavior Boolean true true false false false false true
imageHeight height of the image ImageSize 0 false false false true true
imageWidth width of the image ImageSize 0 false false false true true
zIndex The zIndex property specifies the z-order of a widget and its childs.
When widgets overlap, z-order determines which one covers the other. A widget with a larger zIndex generally covers a widget with a lower one.
The zIndex must be unique within a content.
 UInteger no defaultValue
defined		 false false true true true
left absolute position measured from left boundary of parent container Integer no defaultValue
defined		 false false false true true
top absolute position measured from top boundary of parent container Integer no defaultValue
defined		 false false false true true
height outer height of widget Size 150 false false false true true
width outer width of widget Size 200 false false false true true

Styleable Properties

name type description defaultValue
borderWidth PixelValCollection

Sets the width of the border of the widget. For further information, please check its type

 1px
cornerRadius PixelValCollection

Sets the radius of the widget rounded corners. For further information, please check its type

 0px
backColor Color

Sets the background color of the group-box

 transparent
headerBackColor Color

Sets the background color of the group-box header

 transparent
headerGradient Gradient

Background as a gradient
contentGradient Gradient

Background as a gradient
borderColor ColorCollection

Sets the border color of the group-box. For further information, please check its type

 #DFDFDF
borderStyle BorderStyle

Style of the Border of the widget

 solid
textColor Color

Sets the color of the header text

 #000000
imageColor Color

Color of the image - only apply if a SVG image is used

 #000000
fontName FontName

Fontname of the text

 Arial
fontSize PixelVal

Fontsize of the text in pixel

 12px
bold Boolean

If true font style is bold

 true
italic Boolean

If true font style is italic

 false
textAlign brease.enum.TextAlign

Alignment of the text

 center
opacity Opacity

Opacity of the widget

 1
shadow Shadow

Shadow of the Widget

 none
padding Padding

Padding of the Widget

 0px
margin Margin

Margin of the Widget

 0px 0px 12px 0px

Events

name description arguments
Click Fired when element is clicked on.
  • origin: String

    id of widget that triggered this event

  • horizontalPos: String

    horizontal position of click in pixel i.e '10px'

  • verticalPos: String

    vertical position of click in pixel i.e '10px'

DisabledClick Fired when disabled element is clicked on.
  • origin: String

    id of widget that triggered this event

  • hasPermission: Boolean

    defines if the state is caused due to missing roles of the current user

  • horizontalPos: String

    horizontal position of click in pixel i.e '10px'

  • verticalPos: String

    vertical position of click in pixel i.e '10px'

EnableChanged Fired when operability of the widget changes.
  • value: Boolean

    operability

FocusIn Fired when the widgets gets focus
FocusOut Fired when the widgets lost focus
MouseDown Fired when widget enters mouseDown state
  • horizontalPos: String

    horizontal position of mouse in pixel i.e '10px'

  • verticalPos: String

    vertical position of mouse in pixel i.e '10px'

MouseUp Fired when widget enters mouseUp state
  • horizontalPos: String

    horizontal position of mouse in pixel i.e '10px'

  • verticalPos: String

    vertical position of mouse in pixel i.e '10px'

OnDragEnter Fired when element has onDragEnter.
  • contentId: String

    content id of the widget that has been entering the droppable widget

  • widgetId: String

    id of the widget that has been entering the droppable widget

OnDragLeave Fired when element has OnDragLeave.
  • contentId: String

    content id of the widget that has been leaving the droppable widget

  • widgetId: String

    id of the widget that has been leaving the droppable widget

OnDrop Fired when element has OnDrop.
  • contentId: String

    content id of the widget that has been dropped on the droppable widget

  • widgetId: String

    id of the widget that has been dropped on the droppable widget

VisibleChanged Fired when the visibility of the widget changes.
  • value: Boolean

    visibility

Actions

name description arguments result
Focus Sets focus on the widget element, if it can be focused and keyboardOperation=true
SetEnable Sets the state of property «enable»
  • value: Boolean

SetStyle
  • value: StyleReference

SetVisible Sets the state of property «visible»
  • value: Boolean

ShowTooltip